Merge experimental OpenAPI support into master #1716

bkoelman · 2025-04-21T09:00:38Z

OpenAPI support for JSON:API is now mostly feature-complete. This PR merges the OpenAPI work we started in 2021 into master.

Contributes to #1046.

QUALITY CHECKLIST

Changes implemented in code
Complies with our contributing guidelines
Adapted tests
Documentation updated

…r-type OpenAPI: Fix "id" parameter in URL to be string

…o there's no need.

…esourceIdentifier -> Identifier, drop Object suffixes

… provider, remove ISchemaRepositoryAccessor, remove OAS caching (no measurable gain)

…by client tests; expand model used for query strings

…sk (makes it easier to keep in sync during development)

…with discriminator

OpenAPI: Support including related resources

…rollerEndpoints

OpenAPI: Filter endpoints based on GenerateControllerEndpoints usage

…apps

OpenAPI: Error responses

Fix OpenAPI example crash in Visual Studio 2022 v17.9.0

Merge master into openapi

Add missing 422 status code in post/patch/delete relationship endpoint

Renames in OAS output: - [ResourceName] Primary Response Document -> Primary [ResourceName] Response Document - [ResourceName] Secondary Response Document -> Secondary [ResourceName] Response Document - Nullable [ResourceName] Secondary Response Document -> Nullable Secondary [ResourceName] Response Document - Data In Response -> Resource In Response - [ResourceName] Data In Response -> Data In [ResourceName] Response - [ResourceName] Attributes In Response -> Attributes In [ResourceName] Response - [ResourceName] Relationships In Response -> Relationships In [ResourceName] Response

Add support for resource inheritance in OpenAPI

Improve code coverage by skipping unreachable code

* Remove left-overs from SDK workaround (#1699) * Update http links to https * Strip namespaces when unit tests log to the Output Window (#1706)

Merge master into openapi

codecov · 2025-04-21T09:09:57Z

Codecov Report

Attention: Patch coverage is 83.17669% with 179 lines in your changes missing coverage. Please review.

Project coverage is 90.78%. Comparing base (67386f3) to head (81ed9a2).
Report is 361 commits behind head on master.

Files with missing lines	Patch %	Lines
...nApiDotNetCore.OpenApi.Client.NSwag/ApiResponse.cs	73.07%	7 Missing ⚠️
...pi.Client.NSwag/BlockedJsonInheritanceConverter.cs	41.66%	7 Missing ⚠️
...piDotNetCore.OpenApi.Client.NSwag/JsonApiClient.cs	95.39%	2 Missing and 5 partials ⚠️
...uckle/JsonApiActionDescriptorCollectionProvider.cs	91.86%	2 Missing and 5 partials ⚠️
...Links/ResourceIdentifierCollectionTopLevelLinks.cs	0.00%	7 Missing ⚠️
...piObjects/Links/ResourceCollectionTopLevelLinks.cs	0.00%	6 Missing ⚠️
...ApiObjects/Documents/CollectionResponseDocument.cs	0.00%	5 Missing ⚠️
...cts/Documents/NullableSecondaryResponseDocument.cs	0.00%	5 Missing ⚠️
...sonApiObjects/Documents/PrimaryResponseDocument.cs	0.00%	5 Missing ⚠️
...nApiObjects/Documents/SecondaryResponseDocument.cs	0.00%	5 Missing ⚠️
... and 44 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1716      +/-   ##
==========================================
+ Coverage   90.64%   90.78%   +0.13%     
==========================================
  Files         355      467     +112     
  Lines       11569    14612    +3043     
  Branches     1909     2299     +390     
==========================================
+ Hits        10487    13265    +2778     
- Misses        706      917     +211     
- Partials      376      430      +54

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…in preview

bkoelman added 30 commits January 14, 2024 13:10

Simplify dependencies: take ResourceType instead of ClrType

9ba5ec3

Fixed: removed unused entries that are not top-level documents

b0fa688

Merge pull request #1438 from json-api-dotnet/openapi-fix-id-paramete…

37f41fe

…r-type OpenAPI: Fix "id" parameter in URL to be string

Do not wrap resource type in allOf. It is never null or documented, s…

5c53abb

…o there's no need.

Extract resource identifier schema generator

64d1503

Fixed: relationship endpoints don't support includes

36a21c6

JsonApiObjects consistency renames: ResourceObject -> ResourceData, R…

ebf4f10

…esourceIdentifier -> Identifier, drop Object suffixes

Injectable schema generators, remove building of intermediate service…

d9261d7

… provider, remove ISchemaRepositoryAccessor, remove OAS caching (no measurable gain)

Add current server into OAS, fix invalid data type warning in examples

e27c98f

Example: Use http handler for writing to the console

2293b1f

Fixed invalid assertions

7e6b6be

Centralize component schema ID templates

5202b7c

Generate controllers for all endpoints in tests, so they can be used …

022285d

…by client tests; expand model used for query strings

Produce OAS file at build time in example, referenced by client on di…

af0846e

…sk (makes it easier to keep in sync during development)

Add baseline copy of Swashbuckle's SchemaGenerator

4e33ee3

Add support for returning included resources using allOf inheritance …

97bd1bc

…with discriminator

Merge pull request #1448 from json-api-dotnet/openapi-includes

6c9aff8

OpenAPI: Support including related resources

Fixed: set visbility of JSON:API action methods based on GenerateCont…

61ab4a9

…rollerEndpoints

Simplify IoC container setup

71db1dd

Merge pull request #1450 from json-api-dotnet/openapi-filter-endpoints

f7f8f8b

OpenAPI: Filter endpoints based on GenerateControllerEndpoints usage

Make more types injectable

01f131e

Use ConfigureAwait in OpenApi.Client, because callers may be desktop …

04f10ef

…apps

Fix incorrect names and order in DocCommentsTests

b192bfa

Emit error response document in OAS

0cd9754

Merge pull request #1460 from json-api-dotnet/openapi-error-responses

2af36db

OpenAPI: Error responses

Fix OpenAPI crash when running in VS with debugger attached, see #1463

dd71370

Merge pull request #1464 from json-api-dotnet/openapi-fix-vs-crash

acc5de2

Fix OpenAPI example crash in Visual Studio 2022 v17.9.0

Fix type/filename mismatch

df5902d

Merge branch 'master' into merge-master-into-openapi

649291c

Merge pull request #1474 from json-api-dotnet/merge-master-into-openapi

69d91d6

Merge master into openapi

bkoelman added 20 commits March 16, 2025 13:31

Merge pull request #1701 from json-api-dotnet/openapi-status-422

aa0e4f0

Add missing 422 status code in post/patch/delete relationship endpoint

Update Swashbuckle to 8.0 (#1702)

fcca17d

Resource inheritance in OpenAPI

b55e165

Rename schema generators for bodies to generators for documents

1564724

Consistency renames of parameters for schema types

c9bb868

Merge pull request #1704 from json-api-dotnet/openapi-inheritance

fb78af3

Add support for resource inheritance in OpenAPI

Improve code coverage by skipping unreachable code

d58306b

Convert switch expressions to if statements to improve code coverage

45696f6

Merge pull request #1705 from json-api-dotnet/improve-coverage

a771afa

Improve code coverage by skipping unreachable code

Merge branch 'master' into merge-master-into-openapi

fde8e80

Merge master into openapi (#1707)

5d49ecb

* Remove left-overs from SDK workaround (#1699) * Update http links to https * Strip namespaces when unit tests log to the Output Window (#1706)

Bump kiota and NSwag (#1708)

b5f0a9e

Add trace logging for component schema generation (#1709)

87f8d52

Merge branch 'master' into merge-master-into-openapi

5a4e8cc

Trim trailing whitespace from files in OpenAPI

7883e69

Merge pull request #1714 from json-api-dotnet/merge-master-into-openapi

cccb011

Merge master into openapi

Document OpenAPI limitations (#1715)

14a44cd

Remove references to openapi branch

95177aa

Remove left-over exclusion for SchemaGenerator.cs

de1a37c

bkoelman added 4 commits April 21, 2025 11:49

Revert unintentional changes, resulting from earlier bad merges

83b0a45

Enable NuGet push for stable JsonApiDotNetCore with OpenAPI packages …

ffd1003

…in preview

Fail at startup when ASP.NET OpenAPI is registered

42c2c7d

Package updates

81ed9a2

bkoelman force-pushed the merge-openapi-into-master branch from 38d4f63 to 81ed9a2 Compare April 21, 2025 11:00

bkoelman added the OpenAPI label Apr 21, 2025

bkoelman marked this pull request as ready for review April 21, 2025 12:12

bkoelman merged commit dd91468 into master Apr 21, 2025
16 checks passed

bkoelman deleted the merge-openapi-into-master branch April 21, 2025 12:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge experimental OpenAPI support into master #1716

Merge experimental OpenAPI support into master #1716

bkoelman commented Apr 21, 2025 •

edited

Loading

codecov bot commented Apr 21, 2025 •

edited

Loading

Merge experimental OpenAPI support into master #1716

Merge experimental OpenAPI support into master #1716

Conversation

bkoelman commented Apr 21, 2025 • edited Loading

QUALITY CHECKLIST

codecov bot commented Apr 21, 2025 • edited Loading

Codecov Report

bkoelman commented Apr 21, 2025 •

edited

Loading

codecov bot commented Apr 21, 2025 •

edited

Loading